home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / gt_power / iput1103.zip / RTMDR114.ZIP / RTG2MDIR.DOC < prev    next >
Text File  |  1991-03-10  |  12KB  |  361 lines
  1.  
  2.                RTG2MDIR   ROUTING.BBS -> GTMDIR.BBS
  3.  
  4.                 Version 1.14
  5.  
  6. The guff at the start
  7.  
  8.    Ever get fed up with ensuring that ROUTING, and GTMDIR are both kept
  9.    uptodate?... checking every week or so to see what is new, and what
  10.    echoes have closed down?... pain in the ar*e isn't it?.. So, here is
  11.    a partial solution to the problem, RTG2MDIR will build GTMDIR for you
  12.    using the data available in your ROUTING and the status of the echoes
  13.    being read in from ECHLIST.BBS. That way, you keep track of the temp
  14.    down, retired etc echoes, as they will be listed in the appropriate
  15.    GTMDIR.???. The composite GTMDIR.BBS available for your users will
  16.    have all the various specialist echoes all grouped together etc
  17.  
  18.  
  19. Even more junk... better read this bit though
  20. ---------------------------------------------
  21.  
  22.                 ----------------
  23.                 -> Guarantee <-
  24.                 ----------------
  25.  
  26.    You're kidding right?.... a fiver says you ain't paid owt for this -
  27.    so as you lose, send me a fiver ( US$10 ) and that'll do me fine for
  28.    registration.
  29.  
  30.    The software is guaranteed to do nothing except occupy several KBytes
  31.    of disk space, and if executed, take up a little RAM, which it might
  32.    free for later use, if it terminates without hanging.
  33.  
  34.  
  35.  
  36.                   ----------
  37.                   Disclaimer
  38.                   ----------
  39.  
  40.    A sign of the times I suppose, you gotta have this or someone will
  41.    try it on.
  42.  
  43.    The author accepts no responsibility for any of the results caused by
  44.    possesion of, or execution of the program, written and distributed by
  45.    me as RTG2MDIR.
  46.  
  47.    If anything happens at all, then it isn't my fault, no responsibility
  48.    can, or will, be accepted for any results whatsoever which may or may
  49.    not be be directly or indirectly traced to the presence and / or the
  50.    execution of this program.
  51.  
  52.  
  53.             -----------------------------
  54.  
  55.  
  56. What's it do then?.
  57.  
  58.    Reading in GTMDIR.BBS from GTPATH directory, and ROUTING.BBS - also
  59.    from GTPATH, a series of files will be built up, each named GTMDIR
  60.    with the extension E00, E01 etc, contents will be the sections of
  61.    GTMDIR.BBS containing the E01, E02 etc etc echoes.
  62.  
  63. │  All files written are placed in a sub-directory RTG2MDIR.WRK which is
  64. │  created off GTPATH.
  65.  
  66. │   The echo descriptions which are placed in the GTMDIR.??? files in the
  67. │   work directory are will be taken from the following sources:-
  68.  
  69. │    file specified on command line ( ECHOLIST format ),
  70. │        if no file specified on comamnd line, then the
  71. │        config file will be checked for a source, if none
  72. │        is given there, then ECHOLIST.BBS in your GTPATH
  73. │        will be used.
  74.  
  75. │    if none of the above files can be opened, then the descriptions
  76. │    will be taken from GTMDIR.BBS in the GTPATH.
  77.  
  78. │    if GTMDIR.BBS cannot be opened, then the echo descriptions will
  79. │    then be taken from the ROUTING.BBS.
  80.  
  81. │   This gives a multitude of source of echo descriptions. ECHOLIST is
  82. │   the best, because that allows standardisation of echo descriptions.
  83.  
  84.  
  85.  
  86. Command line Switches
  87.  
  88.    /split    this option will read ROUTING.BBS, GTMDIR.BBS and also
  89.         ECHOLIST.BBS from the GTPATH directory and create a few
  90.         files are then created, the name is GTMDIR, and with the
  91.         extension will be the three letters of the echo groups
  92.         that are found in ROUTING.BBS, e.g GTMDIR.E02 etc.
  93.  
  94.         IF the pharase FIDO appears in the description of the
  95.         echo in ROUTING.BBS, then it will always be placed in
  96.         GTMDIR.DOG regardless of whether /CAT ( see below ) is
  97.         used.
  98.  
  99.         NOTE
  100.         these files will overwrite any existing files.
  101.  
  102.         These files will be in the normal GTMDIR.BBS format,
  103.         with access level, directory and description on the
  104.         one line.
  105.  
  106.         If ECHOLIST.BBS cannot be found, then the descriptions
  107.         will be extracted from the existing GTMDIR.BBS, along
  108.         with the access level to the message base.
  109.  
  110.         When GTMDIR isn't available, then the message base
  111.         description and the path are taken from those details
  112.         specified in ROUTING.BBS, and the access level to be
  113.         associated with each echo is as specified in config
  114.         file with the ACCESS parameter, if this has not been
  115. │        specified there, then it defaults to 'A'.
  116.  
  117.         Private, public, netmail, and readonly message bases
  118.         are catered for, as are those flagged as temp down,
  119.         retired, renumbered, new sponsor, unknown sponsor
  120.         etc etc in ECHOLIST.BBS ( new hours is the only one
  121.         I'm not interested ). Oh, and don't worry about any
  122.         password encrypted echoes, these should be handled
  123.         OK in the situation where the echo description is
  124.         taken from ROUTING.BBS, but don't take my word for it,
  125.         check!.
  126.  
  127.    /cat        added this because the ECHOLIST format was changed,
  128.         and a 'new' field added, a three letter category for
  129.         the echoes, e.g. SPT - Sport, CHT - chat etc etc, so
  130.         might as well let you sort our GTMDIR list by echo
  131.         subject, without you having to trail through them all.
  132.  
  133.         There may be the case where an echo is listed in the
  134.         GTMDIR and ROUTING, but has no entry in ECHOLIST, in
  135.         the UK this is rlevant to the E30 echoes. If the /CAT
  136.         switch is used, then these echoes will be listed in
  137.         GTMDIR._#_, yeah, I know it's a wierd extension, but
  138.         can *you* think of something that others might not be
  139.         using?.
  140.  
  141.  
  142.    /missing    as /SPLIT, except does not write the GTMDIR.Exx files.
  143.         just lists inconsistencies.
  144.  
  145.  
  146.    /build    builds a replacement for GTMDIR.BBS from the GTMDIR.xxx
  147.         files found in the GTPATH directory. The order in which
  148.         the files are added is the same as the order in which the
  149.         extensions are specified in the config file. Any files
  150.         whose extensions are NOT listed in the config file are
  151.         not added, but the extensions will be listed when the
  152.         build has completed.
  153.  
  154. │        Will automatically /split if no GTMDIR files are found
  155. │        in the working directory.
  156.  
  157.  
  158.    /source=d:\path\filename.ext
  159.         if specified this is the file where the descriptions
  160.         for the message bases are found. This file must be in
  161.         the same format as ECHOLIST.BBS, either the new or the
  162.         old format. If not specified on the command line, will
  163.         default to ECHOLIST.BBS in GTPATH, unless it is given
  164.         in RTG2MSIR.CFG, e.g. command line overrides whatever
  165.         is given in the config file.
  166.  
  167.         If the file specified with the /SOURCE switch can not
  168.         be opened, then the required data ( echo descriptions )
  169.         will be those found in GTMDIR.BBS.
  170.  
  171.         Note that if GTMDIR cannot be opened, then the echo
  172.         descriptions will be those you have given in your
  173.         ROUTING.BBS
  174.  
  175.  
  176. │  /welcome[=d:\path\filename.ext]
  177. │        creates a WELCOME.BBS in each message area. The text it
  178. │        taken from the appropriate section of FILENAME.EXT. If
  179. │        no file is specified, the ECHODESC.BBS in GTPATH will
  180. │        be used.
  181. │
  182. │        The format of this is simple.
  183. │
  184. │        Exx/yyy
  185. │
  186. │        details of the echo
  187. │
  188. │        Exy/yyz         ( next echo number )
  189. │
  190. │        for Exx/yyy all text between Exx and Exx/yyz will be
  191. │        put in WELCOME.BSS
  192. │
  193. │        The echo numbers must be in column one with no other
  194. │        text on the line. Other than that the text is lifted
  195. │        verbatim.
  196. │
  197. │        This option isn't particularly fast, but will do the
  198. │        job, and afer all, it's not often that you would have
  199. │        to do this anyway.
  200. │
  201. │        ECHODESC.BBS is a perfect source for these details.
  202. │        In fact it's existence led me to doing this bit.
  203.  
  204.  
  205. │  /new        when used with /WELCOME
  206. │        this will write only new WELCOME.BBS files, and will
  207. │               not overwrite any pre-exisitng WELCOME.BBS that you
  208. │        may have already seat up.
  209.  
  210.  
  211. │        when used with /SPLIT
  212. │        will check the specified directory for each of the
  213. │        entries in ROUTING.BBS, and offer the option for you
  214. │        to create the directory.
  215. │        Also applies to /BUILD when RTG2MDR.WRK is empty and
  216. │        /BUILD does a split.
  217.  
  218. │        When a directory has been determined as missing, you
  219. │        will be prompted to create it, skip over this one,
  220. │        create this and all further missing directories, and
  221. │        finally you can ignore this one, and all further ones.
  222.  
  223.  
  224.    /old[nn]    checks MAILIN to determine last bag delivered for each
  225.         echo and copies entries in GTMDIR.BBS which are older
  226.         than nn days to GTMDIR.OLD
  227.  
  228.         NOTE if no qbags are found, it will be assumed that
  229.         this is a new echo.
  230.  
  231.         /* NOT YET AVAILABLE */
  232.  
  233.  
  234.    Config file
  235.  
  236.    The config file - which must be located in the GTPATH directory -
  237.    RTG2MDIR.CFG has the following structure
  238.  
  239.            DEFAULT=d:\path\name.ext
  240.            MAILDRIVE=d:
  241.            EXTENSIONS    this MUST be on first column
  242.            NET
  243.            LOC
  244.            E00
  245.            E01
  246.            E02
  247.            E03
  248.            E05
  249.            E06
  250.            E10
  251.            E30    This comment appears in composite GTMDIR
  252.            END
  253.            ACCESS = A
  254.  
  255.     the extensions are in the order in which the GTMDIR.ext files
  256.     are to be concatenated. If the extension is not found in this
  257.     file, then it will not be included in the concatenated file
  258.     created with the /build switch.
  259.  
  260.     This file is fairly free format, any text after the data is
  261. │    disregarded and can be used as comments. Text following the
  262. │    extensions in either the CATEGORIES or EXTENSIONS sections
  263. │    will appear before the first message base in the composite
  264. │    file. This allows you to add a little one liner comment at
  265. │    the start of each section, this gives the users another way
  266. │    of seeing what the echo subjects are.
  267. │
  268. │    Refer to the sample RTG2MDR.CFG enclosed in the ZIP.
  269.  
  270.     If the /CAT switch has been used, I'd suggest that you enter
  271.     all the categories listed in ECHOLIST.BBS in RTG2MDIR.CFG
  272.     under the CATEGORIES section.
  273.  
  274.     There is a special file created for those message areas that
  275.     are 'funny', i.e. may not be in the echolist or whatever. The
  276. │    extension on this file is ".#_#".
  277.  
  278.  
  279. Support
  280.  
  281.    You can either netmail me on 013/300, or subscribe to
  282.  
  283.     E03/607  UK Utilities Support
  284.  
  285.    available from a hub near you now....
  286.  
  287.  
  288. Timings
  289.  
  290.    Running on an IBM PS/2 model 50, 10MHz with co-pro, this program
  291.    takes 1m21s to /SPLIT apart a routing file with 382 echoes listed.
  292.    ECHOLIST.BBS was available to supply the echo descriptions.
  293.  
  294.    /WELCOME switch run on same PC, 43 secs, to write WELCOME.BBS for
  295.    128 echoes, including creating directories, with 60 echoes
  296.    having no description found.
  297.  
  298.    /BUILD took 1m43s, creating GTMDIR with 241 echoes listed.
  299.  
  300.  
  301. Restrictions
  302.  
  303.    Only 400 echoes currently supported, this includes those listed
  304.    in ECHOLIST.BBS, so if ECHOLIST.BBS gets any larger......
  305.  
  306.    Path to message base no more then 30 chars and must include the
  307.    drive letter.
  308.  
  309.    Echo description no more then 60 characters, the description in
  310.    ECHOLIST.BBS is less than this.
  311.  
  312.    Will run with down to 180K of RAM free.
  313.  
  314.  
  315.  
  316.  
  317. Revision History
  318.  
  319. V1.00    19/02/91    initial release
  320.  
  321. v1.10    20/02/91    8 hrs later Perry changed the format of the
  322.             ECHOLIST.BBS file. Thanks Perry.... <grin>
  323.             Gave an excuse to add the /CAT switch.
  324.             This version will work with both formats of
  325.             ECHOLIST.BBS
  326.  
  327. 1.11    21/02/91    source rationalisation - not released.
  328.  
  329. 1.12    22/02/91    now takes comments following extension in
  330.             RTG2MDIR.CFG and places them in the composite
  331.             routing file at the start of each section.
  332.  
  333.             fixed small bug with Netmail/Private/Public
  334.             message bases.
  335.  
  336.             added /WELCOME and /NEW, to place WELCOME.BBS
  337.             in the message directories.
  338.  
  339. 1.13    23/02/91    /WELCOME is a tiny bit faster now. Was taking
  340.             several minutes ( 18m on my PC ), now down to
  341.             about 15s.
  342.  
  343.             /NEW will check for message directories when
  344.             used with /SPLIT, and prompt user to create
  345.             it.
  346.  
  347. 1.14    07/03/91        all this stuff about registration, and it did
  348.                         not work properly. It does now!
  349.                         Improved parameter validation.
  350.                         Now distributed as RTMDRxxx.ZIP
  351.  
  352.  
  353. Credits(?).
  354.  
  355. You, for giving this thing a try.
  356.  
  357. Scott Estes,     The Sprawl   032/004 for ECHODESC ( GTEDxxyy.ZIP )
  358. Perry Alexander, Infostation, 032/001 for ECHOLIST ( GTELxxyy.ZIP )
  359. Oliver Bell,     The Wind,    013.000 for help in distribution
  360.  
  361.